Sum Method

Wintellect PowerCollections

previous page next page

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Computes the sum of this bag with another bag. he sum of two bags is all items from both of the bags. If an item appears X times in one bag, and Y times in the other bag, the sum contains the item (X+Y) times. A new bag is created with the sum of the bags and is returned. This bag and the other bag are unchanged.

Namespace: Wintellect.PowerCollections
Assembly: PowerCollections (in PowerCollections.dll)

Syntax

C#
public OrderedBag<T> Sum( OrderedBag<T> otherBag )

Visual Basic (Declaration)
Public Function Sum ( _ otherBag As OrderedBag(Of T) _ ) As OrderedBag(Of T)

Visual C++
public: OrderedBag<T>^ Sum ( OrderedBag<T>^ otherBag )

Parameters

otherBag: OrderedBag<(Of <T>)>
Bag to sum with.

Return Value

The sum of the two bags.

Remarks

The sum of two bags is computed in time O(M + N log M), where M is the size of the larger bag, and N is the size of the smaller bag.

Exceptions

Exception	Condition
System..::InvalidOperationException	This bag and otherBag don't use the same method for comparing items.
System..::ArgumentNullException	otherBag is null.